home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / perl5 / Mail / Send.pod < prev    next >
Text File  |  2008-07-29  |  3KB  |  141 lines
  1. =head1 NAME
  2.  
  3. Mail::Send - Simple electronic mail interface
  4.  
  5. =head1 INHERITANCE
  6.  
  7. =head1 SYNOPSIS
  8.  
  9.   require Mail::Send;
  10.  
  11.   $msg = Mail::Send->new;
  12.   $msg = Mail::Send->new(Subject => 'example', To => 'timbo');
  13.  
  14.   $msg->to('user@host');
  15.   $msg->to('user@host', 'user2@example.com');
  16.   $msg->subject('example subject');
  17.   $msg->cc('user@host');
  18.   $msg->bcc('someone@else');
  19.  
  20.   $msg->set($header, @values);
  21.   $msg->add($header, @values);
  22.   $msg->delete($header);
  23.  
  24.   # Launch mailer and set headers. The filehandle returned
  25.   # by open() is an instance of the Mail::Mailer class.
  26.   # Arguments to the open() method are passed to the Mail::Mailer
  27.   # constructor.
  28.  
  29.   $fh = $msg->open;   # some default mailer
  30.   $fh = $msg->open('sendmail'); # explicit
  31.   print $fh "Body of message";
  32.   $fh->close          # complete the message and send it
  33.       or die "couldn't send whole message: $!\n";
  34.  
  35. =head1 DESCRIPTION
  36.  
  37. L<Mail::Send|Mail::Send> creates e-mail messages without using the L<Mail::Header|Mail::Header>
  38. knowledge, which means that all escaping and folding must be done by
  39. you!  Simplicity has its price.
  40.  
  41. When you have time, take a look at Mail::Transport
  42.  
  43. =head1 METHODS
  44.  
  45. =head2 Constructors
  46.  
  47. Mail::Send-E<gt>B<new>(PAIRS)
  48.  
  49. =over 4
  50.  
  51. A list of header fields (provided as key-value PAIRS) can be
  52. used to initialize the object.
  53.  
  54. =back
  55.  
  56. =head2 Header fields
  57.  
  58. $obj-E<gt>B<add>(FIELDNAME, VALUES)
  59.  
  60. =over 4
  61.  
  62. Add values to the list of defined values for the FIELDNAME.
  63.  
  64. =back
  65.  
  66. $obj-E<gt>B<bcc>(VALUES)
  67.  
  68. =over 4
  69.  
  70. =back
  71.  
  72. $obj-E<gt>B<cc>(VALUES)
  73.  
  74. =over 4
  75.  
  76. =back
  77.  
  78. $obj-E<gt>B<delete>(FIELDNAME)
  79.  
  80. =over 4
  81.  
  82. =back
  83.  
  84. $obj-E<gt>B<set>(FIELDNAME, VALUES)
  85.  
  86. =over 4
  87.  
  88. VALUES will replace the old values for the FIELDNAME.  Returned is
  89. the LIST of values after modification.
  90.  
  91. =back
  92.  
  93. $obj-E<gt>B<subject>(VALUES)
  94.  
  95. =over 4
  96.  
  97. =back
  98.  
  99. $obj-E<gt>B<to>(VALUES)
  100.  
  101. =over 4
  102.  
  103. =back
  104.  
  105. =head2 Sending
  106.  
  107. $obj-E<gt>B<open>(OPTIONS)
  108.  
  109. =over 4
  110.  
  111. The OPTIONS are used to initiate a mailer object via
  112. L<Mail::Mailer::new()|Mail::Mailer/"Constructors">.  Then L<Mail::Mailer::open()|Mail::Mailer/"Constructors"> is called
  113. with the knowledge collected in this Mail::Send object.
  114.  
  115. =back
  116.  
  117. =head1 SEE ALSO
  118.  
  119. This module is part of the MailTools distribution,
  120. F<http://perl.overmeer.net/mailtools/>.
  121.  
  122. =head1 AUTHORS
  123.  
  124. The MailTools bundle was developed by Graham Barr.  Later, Mark
  125. Overmeer took over maintenance without commitment to further development.
  126.  
  127. Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
  128. Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
  129. Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
  130. For other contributors see ChangeLog.
  131.  
  132. =head1 LICENSE
  133.  
  134. Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
  135. 2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
  136.  
  137. This program is free software; you can redistribute it and/or modify it
  138. under the same terms as Perl itself.
  139. See F<http://www.perl.com/perl/misc/Artistic.html>
  140.  
  141.